API Explorer

⯆

API Explorer

My Collections

Account Access Consents
- Create Account Access Consents
- Get Account Access Consents by ConsentId
- Update Account Access Consent Status by ConsentId
Accounts
- Get Account by AccountId
- Get Accounts
Balances
- Get Accounts Balances by AccountId
- Get Balances
Bank Accounts (Dynamic Endpoint)
- Get Bank Account By Id
- Post Accounts
Beneficiaries
- Get Accounts Beneficiaries by AccountId
- Get Beneficiaries
Direct Debits
- Get Accounts Direct Debits by AccountId
- Get Direct Debits
Domestic Future Dated Payment Consents
- Create Domestic Future Dated Payment Cancellation Consents
- Create Domestic Future Dated Payment Consents
- Get Domestic Future Dated Payment Cancellation Consents by ConsentId
- Get Domestic Future Dated Payment Consents by ConsentId
Domestic Future Dated Payments
- Create Domestic Future Dated Payments
- Get Domestic Future Dated Payment Details by DomesticFutureDatedPaymentId
- Get Domestic Future Dated Payments by DomesticFutureDatedPaymentId
- Patch Domestic Future Dated Payments by DomesticFutureDatedPaymentId
Domestic Payments
- Create Domestic Payments
- Get Domestic Payment details by DomesticPaymentId
- Get Domestic Payments by DomesticPaymentId
Domestic Payments Consents
- Create Domestic Payment Consents
- Get Domestic Payment Consents Funds Confirmation by ConsentId
- Get Domestic Payment Consents by ConsentId
Dynamic Resource Doc
- A test endpoint
Event Notification
- The ASPSP to send an event-notification resource to a TPP
File Payment Consents
- Create File Payment Consents
- Create File Payment Consents File by ConsentId
- Get File Payment Consents File by ConsentId
- Get File Payment Consents by ConsentId
File Payments
- Create File Payments
- Get File Payment Details by FilePaymentId
- Get File Payments Report File by FilePaymentId
- Get File Payments by FilePaymentId
Future Dated Payments
- Get Accounts Future Dated Payments by AccountId
- Get Future Dated Payments
International Payment Consents
- Create International Payment Consents
- Get International Payment Consents Funds Confirmation by ConsentId
- Get International Payment Consents by ConsentId
International Payments
- Create International Payments
- Get International Payment Details by InternationalPaymentId
- Get International Payments by InternationalPaymentId
Offers
- Get Accounts Offers by AccountId
- Get Offers
Parties
- Get Accounts Parties by AccountId
- Get Accounts Party by AccountId
- Get Party
Standing Orders
- Get Accounts Standing Orders by AccountId
- Get Standing Orders
Statements
- Get Accounts Statement Tranactions by AccountId and StatementId
- Get Accounts Statement by AccountId and StatementId
- Get Accounts Statements File by AccountId and StatementId
- Get Accounts Statements by AccountId
- Get Statements
Supplementary Account Info
- Get Accounts Supplementary Account Info by AccountId
Transactions
- Get Accounts Trabnsactions by AccountId
- Get Transactions
_Covid APIDays
- Create new Covid APIDays
- Delete Covid APIDays by id
- Get Covid APIDays List
- Get Covid APIDays by id
- Update Covid APIDays
_Customer Cars
- Create new Customer Cars
- Delete Customer Cars by id
- Get Customer Cars List
- Get Customer Cars by id
- Update Customer Cars
_D Entity1(gh.29.uk)
- Create new D Entity1
- Delete D Entity1 by id
- Get D Entity1 List
- Get D Entity1 by id
- Update D Entity1
_Fish Port
- Create new Fish Port
- Delete Fish Port by id
- Get Fish Port List
- Get Fish Port by id
- Update Fish Port
_Foo Bar
- Create new Foo Bar
- Delete Foo Bar by id
- Get Foo Bar List
- Get Foo Bar by id
- Update Foo Bar
_Insurance Policy(gh.29.uk)
- Create new Insurance Policy
- Delete Insurance Policy by id
- Get Insurance Policy List
- Get Insurance Policy by id
- Update Insurance Policy
_Insurance Premium(gh.29.uk)
- Create new Insurance Premium
- Delete Insurance Premium by id
- Get Insurance Premium List
- Get Insurance Premium by id
- Update Insurance Premium
_March Hare(gh.29.uk)
- Create new March Hare
- Delete March Hare by id
- Get March Hare List
- Get March Hare by id
- Update March Hare
_Obp Activity(obp.testing.01)
- Create new Obp Activity
- Delete Obp Activity by id
- Get Obp Activity List
- Get Obp Activity by id
- Update Obp Activity
_Odometer(gh.29.uk)
- Create new Odometer
- Delete Odometer by id
- Get Odometer List
- Get Odometer by id
- Update Odometer
_Simon Covid
- Create new Simon Covid
- Delete Simon Covid by id
- Get Simon Covid List
- Get Simon Covid by id
- Update Simon Covid
_Sustrans
- Create new Sustrans
- Delete Sustrans by id
- Get Sustrans List
- Get Sustrans by id
- Update Sustrans
_Test Daniel707
- Create new My Test Daniel707
- Create new Test Daniel707
- Delete My Test Daniel707 by id
- Delete Test Daniel707 by id
- Get My Test Daniel707 List
- Get My Test Daniel707 by id
- Get Test Daniel707 List
- Get Test Daniel707 by id
- Update My Test Daniel707
- Update Test Daniel707
_Test1
- Create new Test1
- Delete Test1 by id
- Get Test1 List
- Get Test1 by id
- Update Test1

Log off

BAHRAIN-OBFv1.0.0 (135 APIs)

Anfitrión de la API: https://apisandbox.openbankproject.com

Create Domestic Future Dated Payments

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

Respuesta Exitosa Típica:

								
									{
  "Meta":{
    "FirstAvailableDateTime":{
      
    },
    "TotalPages":0
  },
  "Links":{
    "Last":"http://example.com/aeiou",
    "Prev":"http://example.com/aeiou",
    "Next":"http://example.com/aeiou",
    "First":"http://example.com/aeiou",
    "Self":"http://example.com/aeiou"
  },
  "Data":{
    "Status":"Cancelled",
    "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
    "Debtor":{
      "Name":"Name"
    },
    "CreationDateTime":"2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00",
    "Refund":{
      "Account":{
        "Identification":{
          
        },
        "SchemeName":{
          
        },
        "Name":"Name"
      }
    },
    "DomesticFutureDatedPaymentId":"DomesticFutureDatedPaymentId",
    "Charges":[{
      "Type":{
        
      },
      "Amount":{
        "Amount":{
          
        },
        "Currency":{
          
        }
      },
      "ChargeBearer":{
        
      }
    },{
      "Type":{
        
      },
      "Amount":{
        "Amount":{
          
        },
        "Currency":{
          
        }
      },
      "ChargeBearer":{
        
      }
    }],
    "ConsentId":"ConsentId",
    "Initiation":{
      "SupplementaryData":{
        
      },
      "LocalInstrument":{
        
      },
      "DebtorAccount":{
        "Name":"Name"
      },
      "RemittanceInformation":{
        "RemittanceDescription":"RemittanceDescription",
        "Reference":"Reference"
      },
      "EndToEndIdentification":"EndToEndIdentification",
      "InstructionIdentification":"InstructionIdentification",
      "CreditorAccount":{
        "Identification":{
          
        },
        "SchemeName":{
          
        },
        "Name":"Name"
      },
      "CreditorPostalAddress":{
        "CountrySubDivision":{
          
        },
        "StreetName":{
          
        },
        "Department":{
          
        },
        "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
        "BuildingNumber":{
          
        },
        "TownName":{
          
        },
        "Country":{
          
        },
        "SubDepartment":{
          
        },
        "AddressType":{
          
        },
        "PostCode":{
          
        }
      },
      "InstructedAmount":{
        "Amount":{
          
        },
        "Currency":{
          
        }
      },
      "RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00"
    },
    "ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00"
  }
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.

Métodos de conector::

Version: BAHRAIN-OBFv1.0.0, function_name: by domesticFutureDatedPaymentsPost, operation_id: BAHRAIN-OBFv1.0.0-domesticFutureDatedPaymentsPost Tags: Domestic Future Dated Payments, Mocked-Data,

Get Domestic Future Dated Payment Details by DomesticFutureDatedPaymentId

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

DOMESTIC_FUTURE_DATED_PAYMENT_ID: DOMESTIC_FUTURE_DATED_PAYMENT_ID

JSON response body fields:

Respuesta Exitosa Típica:

								
									{
  "Meta":{
    "FirstAvailableDateTime":{
      
    },
    "TotalPages":0
  },
  "Links":{
    "Last":"http://example.com/aeiou",
    "Prev":"http://example.com/aeiou",
    "Next":"http://example.com/aeiou",
    "First":"http://example.com/aeiou",
    "Self":"http://example.com/aeiou"
  },
  "Data":{
    "PaymentStatus":[{
      "PaymentTransactionId":"PaymentTransactionId",
      "Status":"Accepted",
      "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
      "StatusDetail":{
        "Status":"Status",
        "LocalInstrument":{
          
        },
        "StatusReason":"Cancelled",
        "StatusReasonDescription":"StatusReasonDescription"
      }
    },{
      "PaymentTransactionId":"PaymentTransactionId",
      "Status":"Accepted",
      "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
      "StatusDetail":{
        "Status":"Status",
        "LocalInstrument":{
          
        },
        "StatusReason":"Cancelled",
        "StatusReasonDescription":"StatusReasonDescription"
      }
    }]
  }
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.

Métodos de conector::

Version: BAHRAIN-OBFv1.0.0, function_name: by domesticFutureDatedPaymentsDomesticFutureDatedPaymentIdPaymentDetailsGet, operation_id: BAHRAIN-OBFv1.0.0-domesticFutureDatedPaymentsDomesticFutureDatedPaymentIdPaymentDetailsGet Tags: Domestic Future Dated Payments, Mocked-Data,

Get Domestic Future Dated Payments by DomesticFutureDatedPaymentId

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

DOMESTIC_FUTURE_DATED_PAYMENT_ID: DOMESTIC_FUTURE_DATED_PAYMENT_ID

JSON response body fields:

Respuesta Exitosa Típica:

								
									{
  "Meta":{
    "FirstAvailableDateTime":{
      
    },
    "TotalPages":0
  },
  "Links":{
    "Last":"http://example.com/aeiou",
    "Prev":"http://example.com/aeiou",
    "Next":"http://example.com/aeiou",
    "First":"http://example.com/aeiou",
    "Self":"http://example.com/aeiou"
  },
  "Data":{
    "Status":"Cancelled",
    "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
    "Debtor":{
      "Name":"Name"
    },
    "CreationDateTime":"2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00",
    "Refund":{
      "Account":{
        "Identification":{
          
        },
        "SchemeName":{
          
        },
        "Name":"Name"
      }
    },
    "DomesticFutureDatedPaymentId":"DomesticFutureDatedPaymentId",
    "Charges":[{
      "Type":{
        
      },
      "Amount":{
        "Amount":{
          
        },
        "Currency":{
          
        }
      },
      "ChargeBearer":{
        
      }
    },{
      "Type":{
        
      },
      "Amount":{
        "Amount":{
          
        },
        "Currency":{
          
        }
      },
      "ChargeBearer":{
        
      }
    }],
    "ConsentId":"ConsentId",
    "Initiation":{
      "SupplementaryData":{
        
      },
      "LocalInstrument":{
        
      },
      "DebtorAccount":{
        "Name":"Name"
      },
      "RemittanceInformation":{
        "RemittanceDescription":"RemittanceDescription",
        "Reference":"Reference"
      },
      "EndToEndIdentification":"EndToEndIdentification",
      "InstructionIdentification":"InstructionIdentification",
      "CreditorAccount":{
        "Identification":{
          
        },
        "SchemeName":{
          
        },
        "Name":"Name"
      },
      "CreditorPostalAddress":{
        "CountrySubDivision":{
          
        },
        "StreetName":{
          
        },
        "Department":{
          
        },
        "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
        "BuildingNumber":{
          
        },
        "TownName":{
          
        },
        "Country":{
          
        },
        "SubDepartment":{
          
        },
        "AddressType":{
          
        },
        "PostCode":{
          
        }
      },
      "InstructedAmount":{
        "Amount":{
          
        },
        "Currency":{
          
        }
      },
      "RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00"
    },
    "ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00"
  }
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.

Métodos de conector::

Version: BAHRAIN-OBFv1.0.0, function_name: by domesticFutureDatedPaymentsDomesticFutureDatedPaymentIdGet, operation_id: BAHRAIN-OBFv1.0.0-domesticFutureDatedPaymentsDomesticFutureDatedPaymentIdGet Tags: Domestic Future Dated Payments, Mocked-Data,

Patch Domestic Future Dated Payments by DomesticFutureDatedPaymentId

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

DOMESTIC_FUTURE_DATED_PAYMENT_ID: DOMESTIC_FUTURE_DATED_PAYMENT_ID

JSON response body fields:

Respuesta Exitosa Típica:

								
									{
  "Meta":{
    "FirstAvailableDateTime":{
      
    },
    "TotalPages":0
  },
  "Links":{
    "Last":"http://example.com/aeiou",
    "Prev":"http://example.com/aeiou",
    "Next":"http://example.com/aeiou",
    "First":"http://example.com/aeiou",
    "Self":"http://example.com/aeiou"
  },
  "Data":{
    "Status":"Cancelled",
    "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
    "Debtor":{
      "Name":"Name"
    },
    "CreationDateTime":"2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00",
    "Refund":{
      "Account":{
        "Identification":{
          
        },
        "SchemeName":{
          
        },
        "Name":"Name"
      }
    },
    "DomesticFutureDatedPaymentId":"DomesticFutureDatedPaymentId",
    "Charges":[{
      "Type":{
        
      },
      "Amount":{
        "Amount":{
          
        },
        "Currency":{
          
        }
      },
      "ChargeBearer":{
        
      }
    },{
      "Type":{
        
      },
      "Amount":{
        "Amount":{
          
        },
        "Currency":{
          
        }
      },
      "ChargeBearer":{
        
      }
    }],
    "ConsentId":"ConsentId",
    "Initiation":{
      "SupplementaryData":{
        
      },
      "LocalInstrument":{
        
      },
      "DebtorAccount":{
        "Name":"Name"
      },
      "RemittanceInformation":{
        "RemittanceDescription":"RemittanceDescription",
        "Reference":"Reference"
      },
      "EndToEndIdentification":"EndToEndIdentification",
      "InstructionIdentification":"InstructionIdentification",
      "CreditorAccount":{
        "Identification":{
          
        },
        "SchemeName":{
          
        },
        "Name":"Name"
      },
      "CreditorPostalAddress":{
        "CountrySubDivision":{
          
        },
        "StreetName":{
          
        },
        "Department":{
          
        },
        "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
        "BuildingNumber":{
          
        },
        "TownName":{
          
        },
        "Country":{
          
        },
        "SubDepartment":{
          
        },
        "AddressType":{
          
        },
        "PostCode":{
          
        }
      },
      "InstructedAmount":{
        "Amount":{
          
        },
        "Currency":{
          
        }
      },
      "RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00"
    },
    "ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00"
  }
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.

Métodos de conector::

Version: BAHRAIN-OBFv1.0.0, function_name: by domesticFutureDatedPaymentsDomesticFutureDatedPaymentIdPatch, operation_id: BAHRAIN-OBFv1.0.0-domesticFutureDatedPaymentsDomesticFutureDatedPaymentIdPatch Tags: Domestic Future Dated Payments, Mocked-Data,

Get documentation about the selected endpoints as:

Resource Docs JSON
Swagger 2 JSON
中文版本
Partial Functions

Note: You can list just the APIs that are implemented in a certain version by appending &native=true to the index URL.
API_Explorer Commit

Featured APIs

API Explorer

BAHRAIN-OBFv1.0.0 (135 APIs)

Create Domestic Future Dated Payments

Get Domestic Future Dated Payment Details by DomesticFutureDatedPaymentId

Get Domestic Future Dated Payments by DomesticFutureDatedPaymentId

Patch Domestic Future Dated Payments by DomesticFutureDatedPaymentId